/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.catalina.startup;

import java.util.Enumeration;

/**
 * Abstraction of the set of users defined by the operating system on the
 * current server platform.
 * 
 * @author Craig R. McClanahan
 * @version $Id: UserDatabase.java 939353 2010-04-29 15:50:43Z kkolinko $
 */

public interface UserDatabase {

	// ----------------------------------------------------------- Properties

	/**
	 * Return the UserConfig listener with which we are associated.
	 */
	public UserConfig getUserConfig();

	/**
	 * Set the UserConfig listener with which we are associated.
	 * 
	 * @param userConfig
	 *            The new UserConfig listener
	 */
	public void setUserConfig(UserConfig userConfig);

	// ------------------------------------------------------- Public Methods

	/**
	 * Return an absolute pathname to the home directory for the specified user.
	 * 
	 * @param user
	 *            User for which a home directory should be retrieved
	 */
	public String getHome(String user);

	/**
	 * Return an enumeration of the usernames defined on this server.
	 */
	public Enumeration getUsers();

}
